Document these functions.
authorMatthias Clasen <maclas@gmx.de>
Tue, 10 Feb 2004 01:04:35 +0000 (01:04 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 10 Feb 2004 01:04:35 +0000 (01:04 +0000)
Tue Feb 10 01:58:55 2004  Matthias Clasen  <maclas@gmx.de>

* gtk/gtkcontainer.c (gtk_container_set_focus_hadjustment):
* gtk/gtkcontainer.c (gtk_container_set_focus_vadjustment): Document
these functions.

ChangeLog
ChangeLog.pre-2-10
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
gtk/gtkcontainer.c

index 5c01bd20a67cc8c1b8fed03327c372c0bb2f0580..d57db3acb9e7a774180bf17ab9a5f0c0a6cfcc10 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Tue Feb 10 01:58:55 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_set_focus_hadjustment): 
+       * gtk/gtkcontainer.c (gtk_container_set_focus_vadjustment): Document 
+       these functions.
+
 2004-02-09  Federico Mena Quintero  <federico@ximian.com>
 
        * gtk/gtkfilechooserdefault.c (set_list_model): Request
index 5c01bd20a67cc8c1b8fed03327c372c0bb2f0580..d57db3acb9e7a774180bf17ab9a5f0c0a6cfcc10 100644 (file)
@@ -1,3 +1,9 @@
+Tue Feb 10 01:58:55 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_set_focus_hadjustment): 
+       * gtk/gtkcontainer.c (gtk_container_set_focus_vadjustment): Document 
+       these functions.
+
 2004-02-09  Federico Mena Quintero  <federico@ximian.com>
 
        * gtk/gtkfilechooserdefault.c (set_list_model): Request
index 5c01bd20a67cc8c1b8fed03327c372c0bb2f0580..d57db3acb9e7a774180bf17ab9a5f0c0a6cfcc10 100644 (file)
@@ -1,3 +1,9 @@
+Tue Feb 10 01:58:55 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_set_focus_hadjustment): 
+       * gtk/gtkcontainer.c (gtk_container_set_focus_vadjustment): Document 
+       these functions.
+
 2004-02-09  Federico Mena Quintero  <federico@ximian.com>
 
        * gtk/gtkfilechooserdefault.c (set_list_model): Request
index 5c01bd20a67cc8c1b8fed03327c372c0bb2f0580..d57db3acb9e7a774180bf17ab9a5f0c0a6cfcc10 100644 (file)
@@ -1,3 +1,9 @@
+Tue Feb 10 01:58:55 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_set_focus_hadjustment): 
+       * gtk/gtkcontainer.c (gtk_container_set_focus_vadjustment): Document 
+       these functions.
+
 2004-02-09  Federico Mena Quintero  <federico@ximian.com>
 
        * gtk/gtkfilechooserdefault.c (set_list_model): Request
index 5c01bd20a67cc8c1b8fed03327c372c0bb2f0580..d57db3acb9e7a774180bf17ab9a5f0c0a6cfcc10 100644 (file)
@@ -1,3 +1,9 @@
+Tue Feb 10 01:58:55 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_set_focus_hadjustment): 
+       * gtk/gtkcontainer.c (gtk_container_set_focus_vadjustment): Document 
+       these functions.
+
 2004-02-09  Federico Mena Quintero  <federico@ximian.com>
 
        * gtk/gtkfilechooserdefault.c (set_list_model): Request
index 91f3e88abf21c4a707f45a62e2823ecb14ddc6bf..77f18568f4b6650abbfeb9f21dd1c6b74a54f83e 100644 (file)
@@ -2190,6 +2190,21 @@ gtk_container_unset_focus_chain (GtkContainer  *container)
     }
 }
 
+/**
+ * gtk_container_set_focus_vadjustment:
+ * @container: a #GtkContainer
+ * @adjustment: an adjustment which should be adjusted when the focus is moved among the
+ *   descendents of @container
+ * 
+ * Hooks up an adjustment to focus handling in a container, so when a child of the 
+ * container is focused, the adjustment is scrolled to show that widget. This function
+ * sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical
+ * way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting
+ * the horizontal adjustment.
+ *
+ * The adjustments have to be in pixel units and in the same coordinate system as the 
+ * allocation for immediate children of the container. 
+ */
 void
 gtk_container_set_focus_vadjustment (GtkContainer  *container,
                                     GtkAdjustment *adjustment)
@@ -2229,6 +2244,21 @@ gtk_container_get_focus_vadjustment (GtkContainer *container)
   return vadjustment;
 }
 
+/**
+ * gtk_container_set_focus_hadjustment:
+ * @container: a #GtkContainer
+ * @adjustment: an adjustment which should be adjusted when the focus is moved among the
+ *   descendents of @container
+ * 
+ * Hooks up an adjustment to focus handling in a container, so when a child of the 
+ * container is focused, the adjustment is scrolled to show that widget. This function
+ * sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical
+ * way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting
+ * the vertical adjustment.
+ *
+ * The adjustments have to be in pixel units and in the same coordinate system as the 
+ * allocation for immediate children of the container. 
+ */
 void
 gtk_container_set_focus_hadjustment (GtkContainer  *container,
                                     GtkAdjustment *adjustment)